<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>killerbee</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/killerbee/">KillerBee</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;killerbee
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="killerbee-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package killerbee</h1><p class="nomargin-top"><span class="codelink"><a href="killerbee-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Submodules</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Submodules"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr><td class="summary">
  <ul class="nomargin">
    <li> <strong class="uidlink"><a href="killerbee.GoodFET-module.html">killerbee.GoodFET</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.GoodFETAVR-module.html">killerbee.GoodFETAVR</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.GoodFETCCSPI-module.html">killerbee.GoodFETCCSPI</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.GoodFETatmel128-module.html">killerbee.GoodFETatmel128</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.config-module.html">killerbee.config</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.daintree-module.html">killerbee.daintree</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.dblog-module.html">killerbee.dblog</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.dev_apimote-module.html">killerbee.dev_apimote</a></strong>: <em class="summary">GoodFET Chipcon RF Radio Client for ApiMote Hardware</em>    </li>
    <li> <strong class="uidlink"><a href="killerbee.dev_freakduino-module.html">killerbee.dev_freakduino</a></strong>: <em class="summary">Support from the Freakduino platform from Abika/Freaklabs.</em>    </li>
    <li> <strong class="uidlink"><a href="killerbee.dev_rzusbstick-module.html">killerbee.dev_rzusbstick</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.dev_telosb-module.html">killerbee.dev_telosb</a></strong>: <em class="summary">Support for the TelosB / Tmote Sky platforms, and close clones.</em>    </li>
    <li> <strong class="uidlink"><a href="killerbee.dev_wislab-module.html">killerbee.dev_wislab</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.dev_zigduino-module.html">killerbee.dev_zigduino</a></strong>: <em class="summary">Support is currently only tested with Zigduino r1.</em>    </li>
    <li> <strong class="uidlink"><a href="killerbee.dot154decode-module.html">killerbee.dot154decode</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.kbutils-module.html">killerbee.kbutils</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.openear-module.html">killerbee.openear</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="killerbee.openear.capture-module.html">killerbee.openear.capture</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.openear.gps-module.html">killerbee.openear.gps</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="killerbee.openear.gps.client-module.html">killerbee.openear.gps.client</a></strong>    </li>
    <li> <strong class="uidlink">killerbee.openear.gps.gps</strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.openear.gps.gps%27-module.html">killerbee.openear.gps.gps'</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.openear.gps.misc-module.html">killerbee.openear.gps.misc</a></strong>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="killerbee.openear.scanner-module.html">killerbee.openear.scanner</a></strong>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="killerbee.pcapdlt-module.html">killerbee.pcapdlt</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.pcapdump-module.html">killerbee.pcapdump</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.scapy_extensions-module.html">killerbee.scapy_extensions</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive-module.html">killerbee.zbwardrive</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.capture-module.html">killerbee.zbwardrive.capture</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.db-module.html">killerbee.zbwardrive.db</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.gps-module.html">killerbee.zbwardrive.gps</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.gps.client-module.html">killerbee.zbwardrive.gps.client</a></strong>    </li>
    <li> <strong class="uidlink">killerbee.zbwardrive.gps.gps</strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.gps.gps%27-module.html">killerbee.zbwardrive.gps.gps'</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.gps.misc-module.html">killerbee.zbwardrive.gps.misc</a></strong>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.scanning-module.html">killerbee.zbwardrive.scanning</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.testGPS-module.html">killerbee.zbwardrive.testGPS</a></strong>    </li>
    <li> <strong class="uidlink"><a href="killerbee.zbwardrive.zbwardrive-module.html">killerbee.zbwardrive.zbwardrive</a></strong>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="killerbee.zigbeedecode-module.html">killerbee.zigbeedecode</a></strong>    </li>
  </ul></td></tr>
</table>

<br />
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="killerbee.KillerBee-class.html" class="summary-name">KillerBee</a>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee-module.html#getKillerBee" class="summary-sig-name">getKillerBee</a>(<span class="summary-sig-arg">channel</span>)</span><br />
      Returns an instance of a KillerBee device, setup on the given 
      channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#getKillerBee">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee-module.html#kb_dev_list" class="summary-sig-name">kb_dev_list</a>(<span class="summary-sig-arg">vendor</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">product</span>=<span class="summary-sig-default">None</span>)</span><br />
      Deprecated.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#kb_dev_list">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="killerbee-module.html#show_dev" class="summary-sig-name">show_dev</a>(<span class="summary-sig-arg">vendor</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">product</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">gps</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">include</span>=<span class="summary-sig-default">None</span>)</span><br />
      A basic function to output the device listing.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="killerbee-pysrc.html#show_dev">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'killerbee'"><code class="variable-quote">'</code><code class="variable-string">killerbee</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="getKillerBee"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getKillerBee</span>(<span class="sig-arg">channel</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#getKillerBee">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns an instance of a KillerBee device, setup on the given channel.
  Error handling for KillerBee creation and setting of the channel is 
  wrapped and will raise an Exception().</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>A KillerBee instance initialized to the given channel.</dd>
  </dl>
</td></tr></table>
</div>
<a name="kb_dev_list"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">kb_dev_list</span>(<span class="sig-arg">vendor</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">product</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#kb_dev_list">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Deprecated. Use show_dev or call kbutils.devlist.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="show_dev"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">show_dev</span>(<span class="sig-arg">vendor</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">product</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">gps</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">include</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="killerbee-pysrc.html#show_dev">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>A basic function to output the device listing. Placed here for reuse, 
  as many tool scripts were implementing it.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>gps</code></strong> - Provide device names in this argument (previously known as 'gps')
          which you wish to not be enumerated. Aka, exclude these items.</li>
        <li><strong class="pname"><code>include</code></strong> - Provide device names in this argument if you would like only 
          these to be enumerated. Aka, include only these items.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/killerbee/">KillerBee</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Dec 30 17:49:11 2013
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
